/*
 * Copyright (c) 2012-2013 Open Source Community - <http://www.peerfact.org>
 * Copyright (c) 2011-2012 University of Paderborn - UPB
 * Copyright (c) 2005-2011 KOM - Multimedia Communications Lab
 *
 * This file is part of PeerfactSim.KOM.
 * 
 * PeerfactSim.KOM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 * 
 * PeerfactSim.KOM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with PeerfactSim.KOM.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

/**
 * 
 */
package org.peerfact.impl.util.timeoutcollections;

/**
 * Listens to entry timeouts of timeout maps. For efficiency reasons, an event
 * is fired only when the map is cleaned up, not in real time. This is done
 * after every cleanup process in the timeout set. So the firing of the timeout
 * event may occur after the element would literally timeout.
 * 
 * @author Leo Nobach <peerfact@kom.tu-darmstadt.de>
 * 
 * @param <E>
 * @version 05/06/2011
 */
public interface ITimeoutMapListener<K, V> {

	/**
	 * Called when an entry in the timeout map has timed out.
	 * 
	 * @param set
	 *            , the timeout map where the event occurred.
	 * @param key
	 *            , the key that timed out
	 * @param value
	 *            , the value that timed out
	 * @param timeoutTime
	 *            , the time when the event's timeout was actually set, this may
	 *            not be the current time.
	 */
	public void elementTimeouted(TimeoutMap<K, V> map, K key, V value,
			long timeoutTime);

}
